Skip to main content

Get-IMSharedLink

SYNOPSIS​

Retrieves shared links for asset sharing.

SYNTAX​

list (Default)​

Get-IMSharedLink [-Session <ImmichSession>] [-AlbumId <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

id​

Get-IMSharedLink [-Session <ImmichSession>] -id <String[]> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION​

Gets shared links that allow external access to assets and albums.

EXAMPLES​

EXAMPLE 1​

Get-IMSharedLink

Gets all shared links.

EXAMPLE 2​

Get-IMSharedLink -Id 'link-id'

Gets specific shared link details.

PARAMETERS​

-Session​

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id​

Specific shared link ID to retrieve.

Type: String[]
Parameter Sets: id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-AlbumId​

Filter by album ID to get album shared links.

Type: Object
Parameter Sets: list
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github